<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>BitMaskTextProp (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="BitMaskTextProp (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BitMaskTextProp.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/poi/hslf/model/textproperties/AlignmentTextProp.html" title="class in org.apache.poi.hslf.model.textproperties"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../../org/apache/poi/hslf/model/textproperties/CharFlagsTextProp.html" title="class in org.apache.poi.hslf.model.textproperties"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/poi/hslf/model/textproperties/BitMaskTextProp.html" target="_top">FRAMES</a></li>
<li><a href="BitMaskTextProp.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.apache.poi.hslf.model.textproperties.TextProp">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.hslf.model.textproperties</p>
<h2 title="Class BitMaskTextProp" class="title">Class BitMaskTextProp</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">org.apache.poi.hslf.model.textproperties.TextProp</a></li>
<li>
<ul class="inheritance">
<li>org.apache.poi.hslf.model.textproperties.BitMaskTextProp</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../../org/apache/poi/hslf/model/textproperties/CharFlagsTextProp.html" title="class in org.apache.poi.hslf.model.textproperties">CharFlagsTextProp</a>, <a href="../../../../../../org/apache/poi/hslf/model/textproperties/ParagraphFlagsTextProp.html" title="class in org.apache.poi.hslf.model.textproperties">ParagraphFlagsTextProp</a></dd>
</dl>
<hr>
<br>
<pre>public class <strong>BitMaskTextProp</strong>
extends <a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a>
implements java.lang.Cloneable</pre>
<div class="block">Definition of a special kind of property of some text, or its 
  paragraph. For these properties, a flag in the "contains" header 
  field tells you the data property family will exist. The value
  of the property is itself a mask, encoding several different
  (but related) properties</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.apache.poi.hslf.model.textproperties.TextProp">
<!--   -->
</a>
<h3>Fields inherited from class&nbsp;org.apache.poi.hslf.model.textproperties.<a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a></h3>
<code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#dataValue">dataValue</a>, <a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#maskInHeader">maskInHeader</a>, <a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#propName">propName</a>, <a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#sizeOfDataBlock">sizeOfDataBlock</a></code></li>
</ul>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/BitMaskTextProp.html#BitMaskTextProp(int, int, java.lang.String, java.lang.String[])">BitMaskTextProp</a></strong>(int&nbsp;sizeOfDataBlock,
               int&nbsp;maskInHeader,
               java.lang.String&nbsp;overallName,
               java.lang.String[]&nbsp;subPropNames)</code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/BitMaskTextProp.html#clone()">clone</a></strong>()</code>
<div class="block">Clone, eg when you want to actually make use of one of these.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/BitMaskTextProp.html#getSubPropMatches()">getSubPropMatches</a></strong>()</code>
<div class="block">Fetch the list of if the sub properties match or not</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/BitMaskTextProp.html#getSubPropNames()">getSubPropNames</a></strong>()</code>
<div class="block">Fetch the list of the names of the sub properties</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/BitMaskTextProp.html#getSubValue(int)">getSubValue</a></strong>(int&nbsp;idx)</code>
<div class="block">Fetch the true/false status of the subproperty with the given index</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/BitMaskTextProp.html#getWriteMask()">getWriteMask</a></strong>()</code>
<div class="block">As we're purely mask based, just set flags for stuff
  that is set</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/BitMaskTextProp.html#setSubValue(boolean, int)">setSubValue</a></strong>(boolean&nbsp;value,
           int&nbsp;idx)</code>
<div class="block">Set the true/false status of the subproperty with the given index</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/hslf/model/textproperties/BitMaskTextProp.html#setValue(int)">setValue</a></strong>(int&nbsp;val)</code>
<div class="block">Set the value of the text property, and recompute the sub
  properties based on it</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.poi.hslf.model.textproperties.TextProp">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;org.apache.poi.hslf.model.textproperties.<a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a></h3>
<code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#getMask()">getMask</a>, <a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#getName()">getName</a>, <a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#getSize()">getSize</a>, <a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#getValue()">getValue</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="BitMaskTextProp(int, int, java.lang.String, java.lang.String[])">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BitMaskTextProp</h4>
<pre>public&nbsp;BitMaskTextProp(int&nbsp;sizeOfDataBlock,
               int&nbsp;maskInHeader,
               java.lang.String&nbsp;overallName,
               java.lang.String[]&nbsp;subPropNames)</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getSubPropNames()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubPropNames</h4>
<pre>public&nbsp;java.lang.String[]&nbsp;getSubPropNames()</pre>
<div class="block">Fetch the list of the names of the sub properties</div>
</li>
</ul>
<a name="getSubPropMatches()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubPropMatches</h4>
<pre>public&nbsp;boolean[]&nbsp;getSubPropMatches()</pre>
<div class="block">Fetch the list of if the sub properties match or not</div>
</li>
</ul>
<a name="getWriteMask()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getWriteMask</h4>
<pre>public&nbsp;int&nbsp;getWriteMask()</pre>
<div class="block">As we're purely mask based, just set flags for stuff
  that is set</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#getWriteMask()">getWriteMask</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a></code></dd>
</dl>
</li>
</ul>
<a name="setValue(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setValue</h4>
<pre>public&nbsp;void&nbsp;setValue(int&nbsp;val)</pre>
<div class="block">Set the value of the text property, and recompute the sub
  properties based on it</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#setValue(int)">setValue</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a></code></dd>
</dl>
</li>
</ul>
<a name="getSubValue(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getSubValue</h4>
<pre>public&nbsp;boolean&nbsp;getSubValue(int&nbsp;idx)</pre>
<div class="block">Fetch the true/false status of the subproperty with the given index</div>
</li>
</ul>
<a name="setSubValue(boolean, int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setSubValue</h4>
<pre>public&nbsp;void&nbsp;setSubValue(boolean&nbsp;value,
               int&nbsp;idx)</pre>
<div class="block">Set the true/false status of the subproperty with the given index</div>
</li>
</ul>
<a name="clone()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>clone</h4>
<pre>public&nbsp;java.lang.Object&nbsp;clone()</pre>
<div class="block"><strong>Description copied from class:&nbsp;<code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#clone()">TextProp</a></code></strong></div>
<div class="block">Clone, eg when you want to actually make use of one of these.</div>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html#clone()">clone</a></code>&nbsp;in class&nbsp;<code><a href="../../../../../../org/apache/poi/hslf/model/textproperties/TextProp.html" title="class in org.apache.poi.hslf.model.textproperties">TextProp</a></code></dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/BitMaskTextProp.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/poi/hslf/model/textproperties/AlignmentTextProp.html" title="class in org.apache.poi.hslf.model.textproperties"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../../org/apache/poi/hslf/model/textproperties/CharFlagsTextProp.html" title="class in org.apache.poi.hslf.model.textproperties"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/poi/hslf/model/textproperties/BitMaskTextProp.html" target="_top">FRAMES</a></li>
<li><a href="BitMaskTextProp.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#fields_inherited_from_class_org.apache.poi.hslf.model.textproperties.TextProp">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li>FIELD&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
